Operations

This section describes miscellaneous 3DComment operations.

This task shows you how to:

Start and Stop Embedded TomEE+ on Windows or Linux

Windows:

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

To start and stop the embedded TomEE on Windows: start and stop the 3DEXPERIENCE R2022x 3DComment TomEE service.

Linux:

To start embedded TomEE on Linux, run the following command: <3DCommentInstallPath>/linux_a64/code/tomee/bin/startup.sh .

To stop embedded TomEE on Linux, run the following command: <3DCommentInstallPath>/linux_a64/code/tomee/bin/shutdown.sh -force .

Start and Stop External TomEE+ on Windows/Linux

Windows:

<externalTomEEInstallPath>\bin\startup.bat on Windows

<externalTomEEInstallPath>\bin\shutdown.bat on Windows

Linux:

<externalTomEEInstallPath>/bin/startup.sh on Linux

<externalTomEEInstallPath>/bin/shutdown.sh-force on Linux

Configuring External TomEE+ Windows Service

When using an external TomEE+ on Windows as a service, it needs some additional configuration:

Edit the TomEE+ windows service settings by running the following command (with administrator rights):

<3DCommentInstallPath>\win_b64\code\command\ExternalTomEE_updateService.bat <TomEEServiceName>

This command line updates the external TomEE+ service registry.

Note:
  • Executing this command line several times would create duplicate setting entries in the registry.
  • Moreover the external TomEE+ service registry is not cleaned when uninstalling the 3DComment application.

Refer to the TomEE+ Windows service documentation page for editing and cleaning service settings stored at the following locations in the Windows Registry:

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

Change installation parameters

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

Using the reconfiguration tool, you can modify these parameters without reinstalling the whole service.

For more information, see Installation and Setup: Install: 3DEXPERIENCE Platform: Reconfiguring the 3DEXPERIENCE Platform Installation

Configure the 3DEXPERIENCE platform with a single FQDN

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 3DComment service installation, to send the cookie name to the shared configuration.

  1. Edit 3DComment securityContext.xml file:

    For external TomEE+ on Linux , go to <externalTomEEInstallPath>/webapps/3dcomment/WEB-INF/classes/securityContext.xml

    For external TomEE+ on Windows, go to <externalTomEEInstallPath>\webapps\3dcomment\WEB-INF\classes\securityContext.xml

    For embedded TomEE+ on Linux , go to <3DCommentInstallPath>/linux_a64/code/tomee/webapps/3dcomment/WEB-INF/classes/securityContext.xml

    For embedded TomEE+ on Windows, go to <3DCommentInstallPath>\win_b64\code\tomee\webapps\3dcomment\WEB-INF\classes\securityContext.xml

  2. Update these two properties inside the beans casAuthenticationFilterForLogin, casAuthenticationFilter and casValidationFilter.

    <property name="serverIdCookieName" value="3DCOMMENTSERVERID" />

    <property name="serverIdParamName" value="3dcommentserverid" />

  3. Start and stop the external / embedded TomEE+ as described in this section.

Configure the header name used for the session affinity

x-dsp-client-node is the default header name and is hardcoded in the code of the filters.

If you want to change the name of this header, you need to proceed as explained below:

  1. Edit 3DComment securityContext.xml file:

    Add the following line:<property name="originalClientNodeHeaderName" value= "[YOUR_NEW_HEADER_NAME]" /> in the casAuthenticationFilterForLogin, casAuthenticationFilter and casValidationFilter beans sections.

    For external TomEE+ on Linux , go to <externalTomEEInstallPath>/webapps/3dcomment/WEB-INF/classes/securityContext.xml

    For external TomEE+ on Windows, go to <externalTomEEInstallPath>\webapps\3dcomment\WEB-INF\classes\securityContext.xml

    For embedded TomEE+ on Linux , go to <3DCommentInstallPath>/linux_a64/code/tomee/webapps/3dcomment/WEB-INF/classes/securityContext.xml

    For embedded TomEE+ on Windows, go to <3DCommentInstallPath>\win_b64\code\tomee\webapps\3dcomment\WEB-INF\classes\securityContext.xml

  2. Start and stop the external / embedded TomEE+ as described in this section.

Use the Diagnosing tool

Once the 3DEXPERIENCE platform has been installed, you can use the Diagnosis tool to check that the services have been correctly installed and configured.

For more information, see Installation and Setup: Install: 3DEXPERIENCE Platform: Diagnosing the 3DEXPERIENCE Platform Installation.