Installing and Deploying the ENOVIAvpm Connector

This task shows you how to install the ENOVIAvpm connector on the server side using TomEE.

Important:
  • The installation procedure described below (whatever the preferred option) is not supported on AIX since the AIX operating system is not supported by the 3DEXPERIENCE platform. However, it is possible to manually deploy the WAR file generated on Windows or Linux then transfer it to an AIX computer, to be run on a manually set up TomEE. See Deploy Manually on AIX.
  • TomEE and ENOVIAAppSrvforENOVIAvpmandENOVIAVPMV5Connectors must 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).

What You Should Know About Server Management

Before you begin:
  • The server manager used is a Java servlet that can be integrated in a standard Apache TomEE application server. It can be addressed by the ENOVIAvpm connector using the standard http protocol. It starts and stops the connection to the ENOVIAvpm server on any remote machine required to access the ENOVIAvpm data.
  • To be able to access ENOVIAvpm data, you must connect to an AIX or Windows machine hosting a SDAM (http dispatcher). The SDAM daemon makes it possible for the clients to connect to a VPM machine and must therefore always be running.
  • The server manager can be contacted by any ENOVIAvpm provider using the same URL.
  • No modification of any other software is required to work with this version of the server manager, thus ensuring cross-compatibility of the server manager with any version of the provider or ENOVIAvpm server.
  • The ENOVIAvpm server authentication client with a local user i.e. a user known only to the UNIX machine is not supported.

Install on Windows or Linux

  1. Install and Deploy the WAR File in TomEE
  2. then EITHER:
    OR:
    • first Install an External TomEE then use the ENOVIAvpm installer that generates the WAR and automatically deploys the WAR file in TomEE
    OR:
    • first Install the Embedded TomEE then use the ENOVIAvpm installer that generates the WAR and automatically deploys the WAR file in TomEE. The TomEE is then installed on Windows or Linux as a "service".

Install and Deploy the WAR File in TomEE

This task shows you how to generate, from the 3DEXPERIENCE media ENOVIAAppSrvforENOVIAvpmandENOVIAVPMV5Connectors, 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. Enter either the 64-bit server JRE path or the 64-bit JDK path. Click Next >.
    Note: The Java path is detected automatically if the required level is installed.
  6. Select ENOVIAvpm as the target server. Click Next >.
  7. Provide the following information required for V4 installation purposes:
    • the ENOVIAvpm remote server host name
    • the ENOVIAvpm remote server port (the value must be between 1024 and 65535)
    • the ENOVIAvpm remote server time-out value in milliseconds (default: 1h).
  8. In the dialog box that now appears, check to make sure that the displayed information matches the selections you have just made.
  9. To correct any of the information, click Back >.
  10. If the displayed information is correct, click Install >.
  11. Close the window when the installation is completed.
  12. Check to make sure that the file has been generated at:<install_path>\<WAR name>\distrib\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.

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.

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. Select ENOVIAvpm. Click Next >.
  10. Provide the following information required for V5 installation purposes:
    • the ENOVIAvpm remote server host name
    • the ENOVIAvpm remote server port (the value must be between 1024 and 65535)
    • the ENOVIAvpm remote server time-out value in milliseconds (default: 1h).
    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. Close the window when the installation is completed.
  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
    • 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.

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 >.
    Note: The Java path is detected automatically if the required level is installed.
  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. Click ENOVIAvpm. Click Next >.
  12. Provide the following information required for V4 installation purposes:
    • the ENOVIAvpm remote server host name
    • the ENOVIAvpm remote server port (the value must be between 1024 and 65535)
    • the ENOVIAvpm remote server time-out value in milliseconds (default: 1h).
    Click Next >.
  13. In the dialog box that now appears, check to make sure that the displayed information matches the selections you have just made. Click Next >.
  14. To correct any of the information, click Back >.
  15. If the displayed information is correct, click Install >.
  16. Close the window when the installation is completed.
  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
    • 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.

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 >.
    Note: The Java path is detected automatically if the required level is installed.
  7. Uncheck the box Install the embedded Apache TomEE +.. Click Next >.
  8. Provide a valid TomEE path. Click Next >.
  9. Click ENOVIAvpm. Click Next >.
  10. Provide the following information required for V4 installation purposes:
    • the ENOVIAvpm remote server host name
    • the ENOVIAvpm remote server port (the value must be between 1024 and 65535)
    • the ENOVIAvpm remote server time-out value in milliseconds (default: 1h).
    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. Close the window when the installation is completed.
  15. 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>\<WAR name>\<OS>\code\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.

Edit Installation Parameters

This task shows you how to edit the installation parameters you set when first implementing the server manager.

  1. It is possible for an administrator to edit the configuration file VPMV4ServerManager.properties, located amongst the generated WAR or EAR files. To do this, type the following URL in any web browser:
    http://<esm_host>:<esm_port>/<WAR name>/config

    The following web page is displayed:



  2. Modify the parameters then click the Save configuration button.

Deploy Manually on AIX

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

  1. On an intermediate Windows computer, Install and Deploy the WAR File in TomEE.
  2. Transfer the WAR file from the Windows computer to the target AIX computer using the binary mode (and not the ASCII one).
  3. Complete the manual deployment i.e. Download TomEE from the Internet yourself then Deploy the WAR File in TomEE.
  4. 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 .
  5. In the Installation Directory and Vault File Directory fields, replace the dummy paths you entered earlier with the correct UNIX ones.

Monitor the Server Manager

This task shows you how to obtain information regarding the status of the ENOVIAvpm server manager and the processes launched on the ENOVIAvpm server.

  1. Using any web browser, enter the following url:
    http://<esm_host>:<esm_port>/<WAR name>/vpm/Status

    The server manager requests status information from the SDAM daemon. The SDAM daemon runs a monitoring script (getSDAMChildStatus.sh) stored at a predefined location to collect the information on the SDAM processes.

    The server manager then adds its own information to the script output before returning it all to the user. In this way, information from both the SDAM daemon and the server manager is combined resulting in a report containing the following information:

    • from the SDAM daemon:
      • the memory size and processor usage of the SDAM daemon process
      • the number of SDAMChild processes launched on the machine
      • the number of SDAMChild processes currently active on the machine
      • the memory size and processor usage of each SDAMChild process (default categories of getSDAMChildStatus.sh).
    • from the ENOVIAvpm server manager:
      • the version and install parameters of the server manager
      • the number of requests received by the server manager along with the bytes sent and received.
    Notes:
    • You can modify the monitoring script getSDAMChildStatus.sh so as to receive the type of information you choose. However, the output must comply with the delivered xsd file.
    • While the SDAM daemon is waiting for the output of the script, it cannot service any incoming request. The script must therefore avoid performing time-consuming operations.
  2. You can now analyze the results of your request
    which might look something like this:
    <ESMStatus time="2018-02-01T14:45:34">
  <ENOVIAServerManager build="B214D09" bytesReceived="198K" bytesSent="144K"
                       requests="14" uptime="0 03:25:22" version"V6R2018x" />
  <SDAMDaemon childRunning="3" childStarted="10" cpu="00:00:00" mem="12000K"
               uptime="2 22:44:18">
         <SDAMChild cpu="00:00" mem="1552K"/>
         <SDAMChild cpu="00:00" mem="1528K"/>
         <SDAMChild cpu="00:10" mem="1696K"/>
          <USERDATA>...</USERDATA>
   </SDAMDaemon>>
</ESMStatus>
    Note: This report is an xml file that you can format using an xsl style sheet.

    Meaning of the tags and attributes in the report

    • ESMStatus: an XML tag returned for each monitoring request containing the ENOVIAServerManager and SDAMDaemon tags. The time attribute indicates the time when the information was obtained.
    • ENOVIAServerManager: a tag containing information on the ENOVIAvpm Server Manager such as:
      • build: the build date
      • bytesReceived: number of Kbytes received
      • bytesSent: number of Kbytes sent
      • requests: number of requests received
      • uptime: the length of time the server manager has been running
      • version: the software version
    • SDAMDaemon: a tag containing information on the SDAM daemon itself and its children (SDAMChild tag) such as:
      • childRunning: current number of active SDAMChild processes
      • childStarted: number of SDAMChild processes launched
      • cpu: processor time in seconds
      • SDAMChild and USERDATA: tags as returned by the monitoring script
        Notes:
        • By default, each SDAMChild has the cpu and mem attributes corresponding to their processor and memory usage
        • The monitoring script can be modified to return additional information with the USERDATA tag
    • ERROR tag: reports any error that occurs when the information is being collected:
      <ESMStatus time="2018-02-01T16:22:57">
  <ENOVIAServerManager build="B214" bytesReceived="OK" bytesSent="OK"
                       requests="0"
                       uptime="0 00:22:25" version"V6R2018x" />
  <ERROR>A remote host refused an attempted connect operation.</ERROR>
</ESMStatus>

    Output will be empty if no current SDAM child is running.

    The default monitoring script is delivered in: 

    <InstallPath>/samples/code/bin/getSDAMChildStatus.sh

    Example of output:

    <SDAMChild cpu="00:00" mem="1552K"/>
<SDAMChild cpu="00:00" mem="1528K"/>
<SDAMChild cpu="00:10" mem="1696K"/>
  3. You can reset the counters of the ENOVIA Server Manager using the argument reset=true. For example:
    http:// <esm_host>:<esm_port>/<WAR name>/vpm/Status?reset=true
    The output returned looks like this:
    <ESMStatus reset="true" />