Operations

This section describes miscellaneous 3DSearch operations.

This page discusses:

See Also
Installing 3DSearch
Configuring the Reverse Proxy

External TomEE+

Start and Stop External TomEE+

For Windows, run:

  • <externalTomEEInstallPath>\bin\startup.bat
  • <externalTomEEInstallPath>\bin\shutdown.bat

For Linux, run:

  • <externalTomEEInstallPath>/bin/startup.sh
  • <externalTomEEInstallPath>/bin/shutdown.sh -force

Configure the External TomEE+ Service on Windows

On Windows, the external TomEE+ service requires some additional configuration.

Edit the TomEE+ Windows service settings by running the following command (with administrator rights): <3DPassportInstallPath>\win_b64\code\command\ExternalTomEE_updateService.bat <TomEEServiceName>

This command-line updates the external TomEE+ service registry.

Warning:
  • Executing this command several times creates duplicate setting entries in the registry.
  • The external TomEE+ service registry is not cleared when uninstalling the 3DSearch application.

To edit and clean the service settings stored in the Windows Registry go to the following locations:

  • Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Apache Software Foundation\Procrun 2.0\<TomEEServiceName>\Parameters
  • Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Apache Software Foundation\Procrun 2.0\<TomEEServiceName>\Parameters\Java
Note: For more information, see the Apache TomEE Windows Service documentation.

Embedded TomEE+

Start and Stop the Embedded TomEE+

For Windows:

  • The default name of the Windows service created and started when installing the embedded TomEE is 3DEXPERIENCE R2022x federated TomEE+.

  • To start and stop the embedded TomEE, start and stop the 3DEXPERIENCE R2022x federated TomEE+ service.

For Linux:

  • To start the embedded TomEE, run: <FedSearchInstallPath>/linux_a64/code/tomee/bin/startup.sh
  • To stop the embedded TomEE, run: <FedSearchInstallPath>/linux_a64/code/tomee/bin/shutdown.sh -force

Create the Embedded TomEE+ Service on Windows Manually

On Windows, you can create the 3DEXPERIENCE R2022x federated TomEE+ embedded service manually by running: <FedSearchInstallPath>win_b64\code\command\VENApacheTomEE_createService.bat.

Change Installation Parameters

You may need to change parameters defined during the latest 3DSearch installation.

You can use the reconfiguration tool to modify parameters without reinstalling the whole service. For more information, see Reconfiguring the 3DEXPERIENCE Platform Installation.

Post-Installation for Single FQDN Configuration

To install the 3DEXPERIENCE platform with a single FQDN, you must have one cookie name per service to handle session affinity, and avoid getting some service cookies overridden by other cookies.

In that case, you need to update the configuration after the 3DSearch service installation, to pass the cookie name to the shared configuration.

  1. Edit your FedSearch web.xml file:
    TomEE+ type Path
    Embedded TomEE+
    • Linux: <FedSearchInstallPath>/linux_a64/code/tomee/webapps/federated/WEB-INF/web.xml
    • MS Windows: <FedSearchInstallPath>\win_b64\code\tomee\webapps\federated\WEB-INF\web.xml
    External TomEE+
    • Linux: <externalTomEEInstallPath>/webapps/federated/WEB-INF/web.xml
    • MS Windows: <externalTomEEInstallPath>\webapps\federated\WEB-INF\web.xml
  2. Add the following parameters to the CAS Validation Filter and CAS Authentication Filter configuration of the 3DSearch service: 
    <init-param>
  <param-name>serverIdCookieName</param-name>
  <param-value>3DSEARCHSERVERID</param-value>
</init-param>
<init-param>
  <param-name>serverIdParamName</param-name>
  <param-value>3dsearchserverid</param-value>
</init-param>
  3. Restart the Apache TomEE+ server.

Configure the Header Name Used for Session Affinity

x-dsp-client-node is the default header name and is hardcoded in the filters code. This section describes how to change the header name.

  1. Edit your FedSearch web.xml file:
    TomEE+ type Path
    Embedded TomEE+
    • Linux: <FedSearchInstallPath>/linux_a64/code/tomee/webapps/federated/WEB-INF/web.xml
    • MS Windows: <FedSearchInstallPath>\win_b64\code\tomee\webapps\federated\WEB-INF\web.xml
    External TomEE+
    • Linux: <externalTomEEInstallPath>/webapps/federated/WEB-INF/web.xml
    • MS Windows: <externalTomEEInstallPath>\webapps\federated\WEB-INF\web.xml
  2. Add the same lines to the web.xml file: 
    <filter>
  <filter-name>CAS Authentication Filter</filter-name>
  …
  <init-param>
    <param-name>originalClientNodeHeaderName</param-name>
    <param-value>[YOUR_NEW_HEADER_NAME]</param-value>
  </init-param>
</filter>
<filter>
  <filter-name>CAS Validation Filter</filter-name>
  …
  <init-param>
    <param-name>originalClientNodeHeaderName</param-name>
    <param-value>[YOUR_NEW_HEADER_NAME]</param-value>
  </init-param>
</filter>
  3. Start and Stop the external|embedded TomEE+. See Start and Stop External TomEE+ or Start and Stop the Embedded TomEE+.

Use the Diagnosis Tool

Once the 3DEXPERIENCE platform installation is complete, you can use the Diagnosis tool to verify that services have been correctly installed and configured.

For more information, see Diagnosing the 3DEXPERIENCE Platform Installation.