Operations

This section describes the basic maintenance operations that you can perform in the event of a reboot, to start/stop 3DSwym components.

Component	Linux script / Windows service
3DSwym Foundation	Embedded TomEE+ Linux: as non-root user x3ds, start/stop the 3DSwym Content, Widget Platform and Rich Media Server TomEE+ instance by launching the following command: <3DSwymFoundationinstallpath>/linux_a64/code/tomee/bin/startup.sh: shutdown.sh -force Windows: start and stop the 3DEXPERIENCE R2022x 3DSwym TomEE service. External TomEE+ Linux: <externalTomEEInstallPath>/bin/startup.sh <externalTomEEInstallPath>/bin/shutdown.sh -force Windows: <externalTomEEInstallPath>\bin\startup.bat <externalTomEEInstallPath>\bin\shutdown.bat Configuring external TomEE+ Windows service When you use an external TomEE+ on Windows as a service, it needs some additional configuration. Run the following command to edit the TomEE+ windows service settings (with Administrator rights): <3DSwymInstallPath>\win_b64\code\command\ExternalTomEE_updateService.bat <TomEEServiceName> Warning: Executing this command-line several times creates duplicate setting entries in the registry. The external TomEE+ service registry is not cleaned when uninstalling the 3DSwym application. For more information, see 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
3DSwym Video Converter	Linux: run the following command: <3DSwymVideoConverter_installpath>/linux_a64/code/command/ExternalConverterSvc start Windows: start the 3DEXPERIENCE R2022x 3DSwym ExternalConverterSvc service.
3DSwym Index	Linux: see Installation and Setup: Information Intelligence: Business Analytics Server: Business Analytics Server: Maintaining Your Installation: Administration Tools: Get Started with Command-Line Interfaces Windows: start the Exalead CloudView -R2022x_3DSwym service.

To control 3DSwym Index disk space, read the following user assistance sections:

• Installation and Setup: Administrate: Information Intelligence: Business Analytics Server: Maintaining your Installation: Controlling Disk Space
• Installation and Setup: Administrate: Information Intelligence: Business Analytics Server: Monitoring CloudView: Configuring Logs

Follow the following procedure on the 3DSwym Index machine for a full index rebuild:

<3DSwymInstallPath>\win_b64\code\command\clearExaleadIndex.bat

<3DSwymInstallPath>/linux_a64/code/command/clearExaleadIndex.sh

After a full index rebuild, indexing is automatically scheduled incrementally on a regular basis (nearly every minute).

You can change parameters defined during the latest 3DSwym installation.

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

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

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

1. Edit 3DSwym securityContext.xml file:

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

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

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

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

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

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

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

3. Edit 3DSwym Widgets context.properties file:

   For external TomEE+ on Linux, go to <externalTomEEInstallPath>/webapps/uwp/WEB-INF/classes/context.properties

   For external TomEE+ on Windows, go to <externalTomEEInstallPath>\webapps\uwp\WEB-INF\classes\context.properties

   For embedded TomEE+ on Linux , go to <3DSwymInstallPath>/linux_a64/code/tomee/webapps/uwp/WEB-INF/classes/context.properties

   For embedded TomEE+ on Windows, go to <3DSwymInstallPath>\win_b64\code\tomee\webapps\uwp\WEB-INF\classes\context.properties

4. Update these 2 properties

   uwp.cas.serverIdCookieName = 3DSWYMSERVERID

   uwp.cas.serverIdParamName = 3dswymserverid

5. Edit 3DSwym Rich Media web.xml file:

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

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

   For embedded TomEE+ on Linux , go to <3DSwymInstallPath>/linux_a64/code/tomee/webapps/3dsearch/WEB-INF/web.xml

   For embedded TomEE+ on Windows, go to <3DSwymInstallPath>\win_b64\code\tomee\webapps\3dsearch\WEB-INF\web.xml

6. Update the following parameters

   <init-param>
   <param-name>serverIdCookieName</param-name>
   <param-value>3DSWYMSERVERID</param-value>
   </init-param>
   <init-param>
   <param-name>serverIdParamName</param-name>
   <param-value>3dswymserverid</param-value>
   </init-param>
   

7. Start and Stop the external / embedded TomEE+ as described in this section.

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. For 3DSwym Content web app, edit 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/3dswym/WEB-INF/classes/securityContext.xml

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

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

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

2. Edit 3DSwym Widget Platform uwp-config.properties and add the following line:uwp.cas.originalClientNodeHeaderName = [YOUR_NEW_HEADER_NAME]
   • On Linux, go to <3DSwymInstallPath>/linux_a64/ uwp-config.properties
   • On Windows, go to <3DSwymInstallPath>\win_b64\ uwp-config.properties
3. Add the following lines to the web.xml file for the 3DSwym Rich Media web app.

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

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

   For embedded TomEE+ on Linux , go to <3DSwymInstallPath>/linux_a64/code/tomee/webapps/3dsearch/WEB-INF/web.xml

   For embedded TomEE+ on Windows, go to <3DSwymInstallPath>\win_b64\code\tomee\webapps\3dsearch\WEB-INF\web.xml

   <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>
   

4. Start and Stop the external / embedded TomEE+ as described in this section.

Once 3DSwym is installed, for a given release, you can override the 3DSwym Full Text Search URL in a dedicated technical configuration file.

1. Create or edit application.properties file located at:

   <3DSwymInstallPath>\win_b64\ on Windows

   <3DSwymInstallPath>/linux_a64/ on Linux

   with the following lines:

   search_exalead.host=3dswym.fulltextsearch.mydomain
   search_exalead.port=29010
   search_exalead.suggest.port=29010

2. Start and Stop the external / embedded TomEE+

Once 3DSwym is installed, for a given release, you can override the 3DSwym Full Text Search protocol in a dedicated technical configuration file.

1. Create or edit application.properties file located at:

   <3DSwymInstallPath>\win_b64\ on Windows

   <3DSwymInstallPath>/linux_a64/ on Linux

   with the following lines:

   search_exalead.protocol=https

2. Stop and Start the external / embedded TomEE+

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: 3DEXPERIENCE Platform: 3DEXPERIENCE Platform Installation: Diagnosing the 3DEXPERIENCE Platform Installation.