Installing the DesignSync Connector

The 3DEXPERIENCE platform apps that use the connectors provide the ability to access data stored in a DesignSync repository by using the DesignSync connector. The DesignSync connector must be installed and configured to access the repository.

Before you begin:

The DesignSync connector runs as a deployed application within an Apache TomEE server. The connector registers modules or module category paths within a customer’s existing DesignSync servers. These registered modules or paths are then accessible by the connected apps in 3DEXPERIENCE. If the DesignSync server URL is reachable by the TomEE server hosting the connector, there is no requirement for the connector run on the same network as the DesignSync server.

Warning: The DesignSync connector installation media includes a TomEE server that can be installed to host the connector. This is included for testing purposes and should not be used on a production deployment. For a production environment, deploy the DesignSync connector on a different TomEE server. You can use an existing installation, if you have one available.

While you do not need to install the connector as an administrator, ideally the user installing the connector is also the TomEE server owner and has administrator privileges.

Tip: If you use the provided TomEE server, when you upgrade your connector, the update process renames the existing TomEE configuration server.xml file to server.xml.backup. This allows the user to recover the customizations made to the server.xml file. This may include SSL communications settings.
See Also
Installing the GIT Connector
For a simple installation, you can accept most of the defaults. The first screen reminds you where to view the legal notices for the software.

Installation Directory
Review the default installation directory. You can change the directory by entering the name of the installation directory or browsing to select an installation directory.
Note: Select either an empty folder for the installation or one that contains only the other connector, if you are installing both connectors. If you select a directory that does not exist, the installation process creates it. If you have an existing installation, the system shows you the location of the existing installation. At the prompt, provide a uniquely identifying name for subsequent installations.
Select Installation Component
Select Connector for DesignSync Extension.
Server Java Runtime Environment/Java Development Kit
Install the Server JRE that comes with the product or, if you already have a JRE installed, use the JRE installed on your system. If you do not install the Server JRE, specify the required JRE installation at the prompt on the next page.
Note: Check the platform compatibility list in the Program Directory for a list of compatible versions.
Apache TomEE+ plus
Select the Apache TomEE+ connection port. The default value is 8080. If you specified a different server JRE than the embedded JRE, you have the option to specify an existing TomEE+ server, or install the embedded TomEE+ server. If you specify a server, enter the path to the server. You must have write access to the server path for the installation to succeed.
Note: In addition to the port specified, the installation automatically reserves the next available port number for the server.
Start the Apache TomEE+ Server
Select this to automatically start the TomEE+ server after the DesignSync connector installation completes.
Note: This option is only available if you use the embedded TomEE+ server. Do not automatically start the TomEE+ server if SSL has not been configured, unless the embedded server is running behind a reverse proxy.that manages the SSL.
Deploy DesignSync Connector (webapp)
The installation creates a DesignSync connector web app to install on the TomEE+ server. Select this option to automatically copy the war file and directory generated to the TomEE+ server. If you do not select this option, the administrator must copy the generated war file to the TomEE+ server manually.
Note: When the new .war file is copied to the server, it erases any previous copies of the web app from the TomEE+ server and the directory containing the .war file. It then creates the new version.
Import Customizations
If you have previously installed the DesignSync Connector and have customizations, you can select this option to import customizations from an earlier installation.

The installation procedure concludes by installing and starting up any selected components.

The installation completes with the selections made. For information on creating connections between your connected app and the DesignSync repositories, see the User's Guide for your 3DEXPERIENCE platform app.

Note: To start and stop TomEE+ services on Windows systems, use the Windows services manager ( Windows Control Panel |Administrative Tools|Services) .