Reconfiguring the 3DEXPERIENCE Platform Installation

The reconfiguration tool allows you to tweak certain service installation and deployment parameters, avoiding the need to reinstall the platform.

Administrators often need to change certain values, for example passwords and URLs, after the installation is finished. Reconfigure mode allows you to make these changes without having to re-install platform services from scratch. This mode starts the installation procedure again, allowing you to reconfigure inputs for the supported parameters. If a parameter is not reconfigurable, it is either hidden or greyed out.

You can change values even after installing the latest hot fixes. In this case, you must use the hot fix media to reconfigure the service.

The following services can be reconfigured:

  • 3DPassport
  • 3DDashboard
  • 3DSearch
  • 3DSpace
  • File Collaboration Server
  • 3DSwym
  • 3DComment
  • 3DNotification

When you perform an installation using the embedded TomEE+ application server, the application server will be stopped during the process and restarted with the latest war file after successful reconfiguration. However, if you are using an external TomEE+, you must stop the application server before starting reconfiguration. Reconfiguring does not allow you to switch between external Java and/or external TomEE+ to embedded mode, or vice versa, or to change the installation path.

On Linux, when you try to reconfigure an installation which was installed using embedded TomEE+, the installer may display the error below for existing port:

Incorrect value for "TomEEConnectionPort".
Port value 7070 is not free.
You can enter port value 7072.

Please wait for a few minutes to allow time for the port to be released, then retry the reconfiguration.

To save time, you can also manually stop the TomEE+ server before starting the reconfiguration.

To reconfigure your service installation:

  1. Open a command prompt window with administrator privileges.
  2. Change to the distribution directory.

    The directory is:

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

    where Service_name is, for example: 3DPassport, 3DDashboard, and so forth.

    Note: If a hot fix has been applied, you must use the hot fix media to reconfigure.

  3. Execute the command:
    • Windows: Setup.exe --reconfig for GUI mode, or StartTUI.exe --reconfig for TUI mode.
    • Linux: ./StartGUI.sh --reconfig for GUI mode, or ./StartTUI.sh --reconfig for TUI mode.

    or use this method:

    • Change the directory: <ServiceInstallPath>/InstallData/installer
    • Linux: ./StartGUI.sh --reconfig for GUI mode, or ./StartTUI.sh --reconfig for TUI mode
    • Windows: setup.exe --reconfig for GUI mode, or StartTUI.exe --reconfig for TUI mode.

    The installation procedure then starts.

  4. Select the existing installation path.

    Note: On Windows, the installation path is automatically detected, so it will not be displayed. As a result, the next dialog box panel that allows reconfiguration will be displayed.

  5. Modify the reconfigurable parameters you need to change.

    Note: The previous values for the parameters are already specified, except passwords.

    A list of reconfigurable parameters for each service is provided below.

    Click the Next button to move to the next step each time.

  6. Review your configuration parameters and click Install .

    Once the reconfiguration is complete, the following message informing that reconfiguration is complete appears.

    Click the Close button to exit.

    You can consult the installation logs here:

    install_dir\InstallData\log\CODE\win_b64\ on Windows

    install_dir/InstallData/log/CODE/linux_a64/ on Linux

Here is a list of the reconfigurable parameters, service by service:

ServiceParameters
3DPassport
  • External JAVA Path
  • External TomEE+8 Path
  • TomEE+8 Port (if embedded mode selected when installing GA)
  • Certificate location
  • For Oracle:
    • TNS Path
    • Database Name, User Name, Password
    • You can switch from //Host:Port/Service name to TNS Name and Service name.
  • For SQL Server: Database Name, User Name, Password
  • 3DPassport URL and 3DCompass URL
  • Mail Server Name, Mail Sender Name
  • For reconfiguration of an installation on which the TomEE+ server has not been started: the administrator password
3DDashboard
  • External JAVA Path
  • External TomEE+8 Path
  • TomEE+8 Port (if embedded mode selected when installing GA)
  • Certificate location
  • For Oracle:
    • TNS Path
    • Database Name, User Name, Password
    • You can switch from //Host:Port/Service name to TNS Name and Service name.
  • For SQL Server: Database Name, User Name, Password
  • 3DPassport URL, 3DDashboard URL, 3DCompass URL and 6WTags URL
  • Mail Server Name, Mail Sender Name
  • parameters for loading external widgets, domains details for WebAPI and the shared directory path
3DSearch
  • External JAVA Path
  • External TomEE+8 Path
  • TomEE+8 Port (if embedded mode selected when installing GA)
  • Certificate location
  • 3DPassport URL, 3DSearch URL, 3DSpace URL and 3DSwym URL

3DSpace
  • External JAVA Path
  • For Oracle:
    • TNS Path
    • Database Name, User Name, Password
    • You can switch from //Host:Port/Service name to TNS Name and Service name.
  • For SQL Server:
    • Database Name, User Name, Password
  • Super User Password (creator), Platform Administrator Password (admin_platform)
  • 3DPassport URL, 3DSearch URL, 3DDashboard URL, 3DSpace URL, 3DSwym URL, 3DComment URL and 3DNotification URL

  • Mail Server Name and Mail Sender Name
  • Certificate location
  • On Windows: option to create Tools entries in Start Menu and Shortcuts on the Desktop
  • Stores FCS URL
File Collaboration Server
  • External JAVA Path
  • External TomEE+8 Path
  • TomEE+8 port (if embedded mode selected)
  • Certificate location
  • FCS service URL and Metadata server service URL (default 3DSpace URL)
3DSwym
  • External JAVA Path
  • External TomEE+8 Path
  • TomEE+8 Port (if embedded mode selected when installing GA)
  • Certificate location
  • Shared directory path, log file path and temporary file path
  • 3DPassport URL, 3DDashboard URL, 3DCompass URL, 6WTags URL, 3DSwym URL, 3DComment URL, and 3DNotification URL

  • For Oracle:
    • TNS Path
    • Database Name, User Name, Password
    • You can switch from //Host:Port/Service name to TNS Name and Service name.
  • For SQL Server: Database Name, User Name, Password
  • Option to use as batch server
  • 6WTags administrator user name and password
  • Mail Server Name, Mail Sender Name
3DComment
  • External JAVA Path
  • External TomEE+8 Path
  • TomEE+8 Port (if embedded mode selected when installing GA)
  • Certificate location
  • Shared directory path, log file path and temporary file path
  • 3DPassport URL, 3DDashboard URL, 3DCompass URL, 3DComment URL and 3DNotification URL

  • For Oracle:
    • TNS Path
    • Database Name, User Name, Password
    • You can switch from //Host:Port/Service name to TNS Name and Service name.
  • For SQL Server: Database Name, User Name, Password
3DNotification
  • External JAVA Path
  • Certificate location
  • NodeJS server port
  • For Oracle:
    • TNS Path
    • Database Name, User Name, Password
  • For SQL Server: Database Name, User Name, Password
  • 3DPassport URL, 3DDashboard URL, 3DCompass URL, 3DSwym URL and 3DNotification URL
  • Mail Server Name, Mail Sender Name