Installing 3DSearch

This section describes how to install 3DSearch.

Important:

On Linux, you must log in as user having admin rights.

On Windows, you must belong to the Administrators group or have the privileges assigned to the Administrators group.

Before you begin:
  • Ensure that all 3DSearch prerequisites are installed and running, and check that Administrator and working users have the correct rights.
  • Do not perform the installation as root, but with the dedicated applicative user. For example, x3ds, which is the user you created as explained in Preparing the Installation.
  • Run the TomEE instance with the same x3ds user id. Configure it in the instance configuration file using the TOMCAT_USER variable.
  • The x3ds userid must own the TomEE instance directory, subdirectories, and files.
  • If you want to use an external TomEE, make sure you have configured all the ports before starting the installation.
See Also
Configuring the Reverse Proxy
Uninstalling 3DSearch
  1. Procure the media for your operating system, and prepare to install the software as explained in the DS Installer Guide.

    The name of the installation media is:

    • FederatedSearchFoundation-V6R2022x.Windows64.zip on Windows.
    • FederatedSearchFoundation-V6R2022x.Linux64.tar.gz on Linux.

  2. Untar/unzip the media to create the following directory:

    • FederatedSearchFoundation.Windows64 on Windows.
    • FederatedSearchFoundation.Linux64 on Linux.

  3. Change to the distribution directory.

    The directory is:

    • FederatedSearchFoundation.Windows64/1 on Windows.
    • FederatedSearchFoundation.Linux64/1 on Linux.

    Then start the installation as follows:

    • Windows: double-click setup.exe
    • Linux: ./StartGUI.sh for the GUI, or ./StartTUI.sh

    The installation procedure starts, and a dialog box displays a welcome message.

    Click Next to move to the next step.

  4. Specify the installation directory.



    For example:

    • C:\DassaultSystemes\R2022x\FedSearch on Windows.
    • /usr/DassaultSystemes/R2022x/FedSearch on Linux.
    Note: The installation path cannot contain any space characters.

    Or, click Browse... and navigate to choose the directory.

    Click Next.

  5. Specify if you want to install the embedded Java.



    To install the service, you must have a Java Development Kit (JDK).

    Choosing embedded Java also means choosing the embedded TomEE.

    The This install is for Testing or Demonstration purposes only (it uses an embedded JDK) check box is not selected by default.

    The embedded JDK is installed in:

    • C:\DassaultSystemes\R2022x\FedSearch\win_b64\code\serverjre on Windows
    • /usr/DassaultSystemes/R2022x/FedSearch/linux_a64/code/serverjre on Linux.

    Click Next.

  6. If you did not check the This install is for Testing or Demonstration purposes only (it uses an embedded JDK) check box, specify the Java Home path.



    This is the location of your Java Development Kit (JDK).

    On Windows, the Java location is detected automatically.

    If you use local certificate authority, register these certificates in the Java store using the keytool utility.

    Note: For certificates, use only files with the .cer extension.

    Click Next.
  7. If you decided NOT to install the embedded Java earlier, the setup will prompt you to specify whether you want to install the TomEE+ application server.



    An application server is required to install the service. Check This install is for Testing or Demonstration purposes only (it uses an embedded TomEE+) if you want to install the TomEE+ application server delivered with the media. It will be installed in:

    • <FedSearchInstallPath>\win_b64\code\tomee on Windows.
    • <FedSearchInstallPath>/linux_a64/code/tomee on Linux.

    On Windows, the 3DEXPERIENCE R2022x federated TomEE+ service is created and started.

    On Linux, to start and stop the embedded TomEE+, run:

    • <FedSearchInstallPath>/linux_a64/code/tomee/bin/startup.sh
    • <FedSearchInstallPath>/linux_a64/code/tomee/bin/shutdown.sh -force

    Click Next.

  8. If you decided to use external TomEE+, specify the path of your existing TomEE+ installation.



    Important: For Windows, the external TomEE+ service requires an additional configuration. See External TomEE+.

    Click Next.
  9. If you decided to install the embedded TomEE+, specify the TomEE+ connection port number.



    Choose a listening port number for TomEE+ to listen for HTTP requests. The default is 8084. The automatically fixed TomEE+ shutdown port is 8085 (that is the first free following port).

    Click Next.

    An information box containing the following message appears: 

    Chosen Apache TomEE+ connection port 8084
Automatically fixed TomEE+ shutdown port 8085 (first free following port)

  10. Specify the previously configured, dedicated URL endpoints for the 3DEXPERIENCE platform services.

    Important: Do not use uppercase characters in these URLs (standard form specified in RFC3986).



    Before you do so, check the following:

    • The URLs must contain Fully Qualified Domain Names (FQDN).
    • The URLs must start with http(s):// (and not ftp or other).
    • 3DPassport and 3DSwym must have a root URI if you install all services on the same machine.
    • 3DSearch(federated search).
    • 3DSpace has a root URI.
    • If you install all services on the same machine, the ports must be different.

    Sample URLs (if the services are installed on different machines) are:

    • 3DPassport service URL: the default is: https://3dpassport.mydomain:443/3dpassport
    • 3DSearch service URL: specify the name of the federated search service; the default is: https://3dsearch.mydomain:443/federated
    • 3DSpace service URL: the default is: https://3dspace.mydomain:443/3dspace
    • 3DSwym service URL: the default is https://3dswym.mydomain:443/3dswym

    Click Next.
  11. If you decided to use the embedded Java, specify the certificate location.



    This directory contains the certificates to import into the JVM used by TomEE+. The default is:

    • C:\Windows\Temp\DassaultSystemes on Windows.
    • /tmp/DassaultSystemes on Linux.

    If you leave the path empty, you can import the certificates manually later as a post-installation step. For more information, see Reconfiguring the 3DEXPERIENCE Platform Installation.

    Note: For certificates, use only files with the .cer extension.

    Click Next.
  12. Review your installation parameters and click Install.



  13. Once the installation is complete, the following message displays: 

    The installation program has finished installing 3DEXPERIENCE R2022x on your computer
Installed Components:
3DSearch Service

    Click Close to exit setup.

    You can consult installation logs here:
    • <FedSearchInstallPath>\InstallData\log on Windows.
    • <FedSearchInstallPath>/InstallData/log on Linux.
    Installation log files are prefixed by the installation media name.

    Also consider the following logs for debugging or analyzing:

    • Apache Httpd:
      • <ApacheInstallDir>\logs\* on Windows.
      • <ApacheInstallDir>/logs/* on Linux.
    • Embedded TomEE+ default log directory:
      • <FedSearchInstallPath>\win_b64\code\tomee\logs on Windows.
      • <FedSearchInstallPath>/linux_a64/code/tomee/logs on Linux.
    • External Apache TomEE+ default log directory:
      • <externalTomEEInstallPath>\logs on Windows.
      • <externalTomEEInstallPath>/logs on Linux.

    If you are using embedded TomEE, on Windows, the 3DEXPERIENCE R2022x federated TomEE+ service is created and started.

  14. Copy the content of federated_httpd_fragment.conf available in <INSTALLDIR>\<OS>\templates and add it to the httpd-ssl.conf file available in your reverse proxy configuration directory.

For more information about post-installation commands and quick maintenance operations, see Operations. For more information about 3DSearch administration and customization, see the 3DSearch Administration Guide.