Installing the ENOVIA Standalone ERAgent

This section describes how to install the Standalone ERAgent on ENOVIA.

Important: The Standalone ERAgent Jetty server does not support SSL encryption. Yet, it is possible and highly recommended to map the application behind a reverse proxy with SSL encryption.

Before you begin: The Standalone ERAgent requires:
  • A native ENOVIA installation:
    • Either a server installation
    • Or a LiveCollaborationServer installation
    • Or a StudioModelingPlatformRichClient installation
  • A free HTTP port
  • The jetty JVM works with 512m Xmx. It does not require a large amount of memory. The JVM does not convert any files and does not require a lot of CPU.
Note: The connector (Exalead CloudView host) makes:
  • An HTTP connection to the Standalone ERAgent Jetty.
  • An HTTP(S) connection to all FCS servers to index.
See Also
Standalone ERAgent Security Recommendations
Configuring the Connector in HTTP REST Mode
  1. Unzip the enovia-standalone-agent.zip file in your installation directory.

    The standalone agent package contains the following directories:

    • lib - all required libs to run the Standalone ERAgent
    • scripts - all scripts used to start the Agent up

  2. Run the install script:
    • install.sh for Linux.
    • install.bat for MS Windows.

    Important: Both Linux and Windows scripts use the same command-line arguments.

    Argument Description
    --matrix-home

    (mandatory)

    		The path to the folder that contains the MATRIX-R file.

    It is a FOLDER, not a FILE.

    --galaxy-home The path to the folder that contains the ENOVIA installation binaries.

    For example, E:\ENOVIA\Studio\win_b64\code\bin

    This argument is required if the MATRIX-R file is not stored into the ENOVIA server / studio installation.

    It is not required if --matrix-home points to the ENOVIA installation itself.

    --tns-admin The path to the folder that contains the tnsnames.ora file.

    It is a FOLDER, not a FILE.

    --dsls-config The path to the DSLicSrv.txt file.

    It is a FILE, not a FOLDER.

    This argument is not mandatory if the DSLicSrv.txt file is available in C:\ProgramData\DassaultSystemes\Licenses or /var/DassaultSystemes/Licenses

    --agent-port

    (mandatory)

    		The HTTP port on which the Standalone ERAgent listens.

    This port is used in the URL provided to the connector in the connectivity configuration.

    Note: The +1 port must also be available for the future stop mechanism.

    When you run the script, it creates files in the scripts directory.
    File Description
    agentMxEnv.properties Contains environment variable definitions
    agentMxEnv.sh Called on startup
    agent-version.txt Contains the version of the component itself
    enovia-version.txt Contains the ENOVIA version
    startup.sh or startup.bat Scripts for start
    shutdown.sh or shutdown.bat Scripts for stop
    Note:
    • The Standalone ERAgent writes its logs into the startup/run directory.
    • The Standalone ERAgent has a cache stored in the install/build directory.

      The cache size does not exceed 50MB and contains only an image of the ENOVIA data model (no content is cached).

  3. If the Standalone ERAgent installation is successful, from the scripts directory, you can:
    • Start it with the startup.sh |startup.bat script.
    • Stop it with the shutdown.sh | shutdown.bat script.
  4. To test the Standalone ERAgent connection, run a ping call:

    http://<host>:<port>/enovia-agent/ping

    The response must be: {"status":"success","payloadClass":"com.exalead.enovia.api.rest.common.json.PingResponse","payload":{"status":false}}
    Note: To verify that the login/ password work correctly, go to the Exalead CloudView Administration Console, and in your connector instance, click Check connectivity.

Examples

Example Description
Studio or Live Collaboration Server Context:
  • The Studio has been installed into the /data/johndoe/enovia/enoviaV6R2015x/studio directory
  • The MATRIX-R file is available at /data/johndoe/enovia/enoviaV6R2015x/studio/MATRIX-R
  • The DSLicSrv.txt file is available at /data/johndoe/enovia/DSLicSrv.txt
  • The tnsnames.ora file is available at /data/johndoe/ora11g/network/admin/tnsnames.ora
The install script is called as follows: 
./scripts/install.sh
--matrix-home /data/johndoe/enovia/enoviaV6R2015x/studio
--tns-admin /data/johndoe/ora11g/network/admin
--dsls-config /data/johndoe/enovia/DSLicSrv.txt
--agent-port 9393
Note: The --galaxy-home argument is not specified because it is under /data/johndoe/enovia/enoviaV6R2015x/studio, which is the matrix-home directory. In this case, the galaxy-home corresponds to the /data/johndoe/enovia/enoviaV6R2015x/studio/linux_a64/code/bin directory.
e4all server Context:
  • The server is installed in /home/data/RTV/R421relalodevpril234/server
  • The MATRIX-R file is available at /home/data/RTV/R421relalodevpril234/server/MATRIX-R
  • The DSLicSrv.txt file is available at /var/DassaultSystemes/Licenses/DSLicSrv.txt
  • The tnsnames.ora file is available at /home/data/ora121/network/admin/tnsnames.ora
The install script is called as follows: 
./scripts/install.sh
--matrix-home /home/data/RTV/R421relalodevpril234/server
--tns-admin /home/data/ora121/network/admin
--agent-port 9393